KFbxPatch Class Reference

#include <kfbxpatch.h>

Inheritance diagram for KFbxPatch:

[legend]

List of all members.

---

Detailed Description

A patch is a type of node attribute with parametric surface.

A patch object is useful for creating gently curved surfaces, and provides very detailed control for manipulating complex geometry.

Definition at line 53 of file kfbxpatch.h.

Patch Properties
enum	EPatchType {    eBEZIER = 0,    eBEZIER_QUADRIC = 1,    eCARDINAL = 2,    eBSPLINE = 3,    eLINEAR = 4 }
	Patch types. More...
void	SetSurfaceMode (KFbxGeometry::ESurfaceMode pMode)
	Sets the surface mode.
KFbxGeometry::ESurfaceMode	GetSurfaceMode () const
	Returns the surface mode.
void	InitControlPoints (int pUCount, EPatchType pUType, int pVCount, EPatchType pVType)
	Allocates memory space for the control points array.
int	GetUCount () const
	Returns the number of control points in the U-dimension.
int	GetVCount () const
	Returns the number of control points in the V-dimension.
EPatchType	GetPatchUType () const
	Returns the U-dimension patch type.
EPatchType	GetPatchVType () const
	Returns the V-dimension patch type.
void	SetStep (int pUStep, int pVStep)
	Sets the patch step.
int	GetUStep () const
	Returns the number of divisions between adjacent control points in the U-dimension.
int	GetVStep () const
	Returns the number of divisions between adjacent control points in the V-dimension.
void	SetClosed (bool pU, bool pV)
	Sets closed flags.
bool	GetUClosed () const
	Returns state of the U closed flag.
bool	GetVClosed () const
	Returns state of the V closed flag.
void	SetUCapped (bool pUBottom, bool pUTop)
	Sets U-capped flags.
bool	GetUCappedBottom () const
	Returns state of the bottom U-capped flag.
bool	GetUCappedTop () const
	Returns state of the top U-capped flag.
void	SetVCapped (bool pVBottom, bool pVTop)
	Sets V-capped flags.
bool	GetVCappedBottom () const
	Returns state of the bottom V-capped flag.
bool	GetVCappedTop () const
	Returns state of the top V-capped flag.
Off-loading Serialization section
virtual bool	ContentWriteTo (KFbxStream &pStream) const
	Writes the content of the patch to the given stream.
virtual bool	ContentReadFrom (const KFbxStream &pStream)
	Reads the content of the patch from the given stream.
Public Member Functions
virtual EAttributeType	GetAttributeType () const
	Returns the EAttributeType::ePATCH node attribute type.
void	Reset ()
	Resets the patch to its default values.

---

Member Enumeration Documentation

enum EPatchType

Patch types.

• eBEZIER
• eBEZIER_QUADRIC
• eCARDINAL
• eBSPLINE
• eLINEAR

Enumerator:

eBEZIER
eBEZIER_QUADRIC
eCARDINAL
eBSPLINE
eLINEAR

Definition at line 86 of file kfbxpatch.h.

---

Member Function Documentation

virtual EAttributeType GetAttributeType

(

)

const [virtual]

Returns the EAttributeType::ePATCH node attribute type.

Reimplemented from KFbxGeometry.

void Reset

(

)

Resets the patch to its default values.

void SetSurfaceMode

(

KFbxGeometry::ESurfaceMode

pMode

)

Sets the surface mode.

Parameters:

pMode

Surface mode identifier (see Class KFbxGeometry).

KFbxGeometry::ESurfaceMode GetSurfaceMode

(

)

const [inline]

Returns the surface mode.

Returns:

The current surface mode identifier.

Definition at line 77 of file kfbxpatch.h.

void InitControlPoints	(	int	pUCount,
		EPatchType	pUType,
		int	pVCount,
		EPatchType	pVType
	)

Allocates memory space for the control points array.

Parameters:

	pUCount	Number of U-dimension control points.
	pUType	U-dimension patch type.
	pVCount	Number of V-dimension control points.
	pVType	V-dimension patch type.

int GetUCount

(

)

const [inline]

Returns the number of control points in the U-dimension.

Returns:

The number of control points in the U-dimension.

Definition at line 106 of file kfbxpatch.h.

int GetVCount

(

)

const [inline]

Returns the number of control points in the V-dimension.

Returns:

The number of control points in the V-dimension.

Definition at line 111 of file kfbxpatch.h.

EPatchType GetPatchUType

(

)

const [inline]

Returns the U-dimension patch type.

Returns:

Patch type identifier in the U-dimension.

Definition at line 116 of file kfbxpatch.h.

EPatchType GetPatchVType

(

)

const [inline]

Returns the V-dimension patch type.

Returns:

Patch type identifier in the V-dimension.

Definition at line 121 of file kfbxpatch.h.

void SetStep	(	int	pUStep,
		int	pVStep
	)

Sets the patch step.

The step is the number of divisions between adjacent control points.

Parameters:

	pUStep	Steps in U-dimension.
	pVStep	Steps in V-dimension.

int GetUStep

(

)

const [inline]

Returns the number of divisions between adjacent control points in the U-dimension.

Returns:

Step value in the U-dimension.

Definition at line 133 of file kfbxpatch.h.

int GetVStep

(

)

const [inline]

Returns the number of divisions between adjacent control points in the V-dimension.

Returns:

Step value in the V-dimension.

Definition at line 138 of file kfbxpatch.h.

void SetClosed	(	bool	pU,
		bool	pV
	)

Sets closed flags.

Parameters:

	pU	Set to true if the patch is closed in U dimension.
	pV	Set to true if the patch is closed in V dimension.

bool GetUClosed

(

)

const [inline]

Returns state of the U closed flag.

Returns:

True if the patch is closed in U dimension.

Definition at line 149 of file kfbxpatch.h.

bool GetVClosed

(

)

const [inline]

Returns state of the V closed flag.

Returns:

True if the patch is closed in V dimension.

Definition at line 154 of file kfbxpatch.h.

void SetUCapped	(	bool	pUBottom,
		bool	pUTop
	)

Sets U-capped flags.

Parameters:

	pUBottom	Set to true if the patch is capped at the bottom in the U-dimension.
	pUTop	Set to true if the patch is capped on the top in the U-dimension.

Remarks:

Capping options are saved but not loaded by Motionbuilder because they are computed from the patch topography.

bool GetUCappedBottom

(

)

const [inline]

Returns state of the bottom U-capped flag.

Returns:

True if the patch is capped at the bottom in the U-dimension.

Definition at line 167 of file kfbxpatch.h.

bool GetUCappedTop

(

)

const [inline]

Returns state of the top U-capped flag.

Returns:

True if the patch is capped on the top in the U-dimension.

Definition at line 172 of file kfbxpatch.h.

void SetVCapped	(	bool	pVBottom,
		bool	pVTop
	)

Sets V-capped flags.

Parameters:

	pVBottom	Sets to true if the patch is capped at the bottom in the V-dimension.
	pVTop	Sets to true if the patch is capped on the top in the V-dimension.

Remarks:

Capping options are saved but not loaded by Motionbuilder because they are computed from the patch topography.

bool GetVCappedBottom

(

)

const [inline]

Returns state of the bottom V-capped flag.

Returns:

True if the patch is capped at the bottom.

Definition at line 185 of file kfbxpatch.h.

bool GetVCappedTop

(

)

const [inline]

Returns state of the top V-capped flag.

Returns:

True if the patch is capped on the top.

Definition at line 190 of file kfbxpatch.h.

virtual bool ContentWriteTo

(

KFbxStream &

pStream

)

const [virtual]

Writes the content of the patch to the given stream.

Parameters:

pStream

The destination stream.

Returns:

True if the content is successfully processed by the receiving stream. If it is not successful, returns false.

Reimplemented from KFbxGeometryBase.

virtual bool ContentReadFrom

(

const KFbxStream &

pStream

)

[virtual]

Reads the content of the patch from the given stream.

Parameters:

pStream

The source stream.

Returns:

True if the patch completes with the data received from the stream successfully. If it is not successful, returns false.

Reimplemented from KFbxGeometryBase.